<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
  <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
  <title>dil.semantic.Module</title>
  <link href="./css/style.css" rel="stylesheet" type="text/css"/>
  <!-- <link href="./img/icon.png" rel="icon" type="image/png"/> -->
  <script type="text/javascript" src="./js/jquery.js"></script>
  <script type="text/javascript" src="./js/modules.js"></script>
  <script type="text/javascript" src="./js/quicksearch.js"></script>
  <script type="text/javascript" src="./js/navigation.js"></script>
  <!--<script type="text/javascript" src="./js/jquery.treeview.js"></script>-->
  <script type="text/javascript">
    var g_moduleFQN = "dil.semantic.Module";
  </script>
  
</head>
<body>
<div id="content">
  <h1><a href="./htmlsrc/dil.semantic.Module.html" class="symbol">dil.semantic.Module</a></h1>
  
<p class="sec_header">Author:</p>Aziz Köksal
<p class="sec_header">License:</p>GPL3
 <p><b>Maturity:</b> high.</p>
<dl>
<dt class="decl">alias FileConst.PathSeparatorChar <a class="symbol _alias" name="dirSep" href="./htmlsrc/dil.semantic.Module.html#L22" kind="alias" beg="22" end="22">dirSep</a>; <a title="Permalink to this symbol" href="#dirSep" class="symlink">¶</a><a title="Go to the HTML source file" class="srclink" href="./htmlsrc/dil.semantic.Module.html#L22">#</a></dt>
<dd class="ddef"></dd>
<dt class="decl">class <a class="symbol _class" name="Module" href="./htmlsrc/dil.semantic.Module.html#L25" kind="class" beg="25" end="185">Module</a> : ScopeSymbol; <a title="Permalink to this symbol" href="#Module" class="symlink">¶</a><a title="Go to the HTML source file" class="srclink" href="./htmlsrc/dil.semantic.Module.html#L25">#</a></dt>
<dd class="ddef">
<div class="summary">Represents a semantic D module and a source file.</div>
<dl>
<dt class="decl">SourceText <a class="symbol _variable" name="Module.sourceText" href="./htmlsrc/dil.semantic.Module.html#L27" kind="variable" beg="27" end="27">sourceText</a>; <a title="Permalink to this symbol" href="#Module.sourceText" class="symlink">¶</a><a title="Go to the HTML source file" class="srclink" href="./htmlsrc/dil.semantic.Module.html#L27">#</a></dt>
<dd class="ddef">
<div class="summary">The source file of this module.</div></dd>
<dt class="decl">string <a class="symbol _variable" name="Module.moduleFQN" href="./htmlsrc/dil.semantic.Module.html#L28" kind="variable" beg="28" end="28">moduleFQN</a>; <a title="Permalink to this symbol" href="#Module.moduleFQN" class="symlink">¶</a><a title="Go to the HTML source file" class="srclink" href="./htmlsrc/dil.semantic.Module.html#L28">#</a></dt>
<dd class="ddef">
<div class="summary">Fully qualified name of the module. E.g.: dil.ast.Node</div></dd>
<dt class="decl">string <a class="symbol _variable" name="Module.packageName" href="./htmlsrc/dil.semantic.Module.html#L29" kind="variable" beg="29" end="29">packageName</a>; <a title="Permalink to this symbol" href="#Module.packageName" class="symlink">¶</a><a title="Go to the HTML source file" class="srclink" href="./htmlsrc/dil.semantic.Module.html#L29">#</a></dt>
<dd class="ddef">
<div class="summary">E.g.: dil.ast</div></dd>
<dt class="decl">string <a class="symbol _variable" name="Module.moduleName" href="./htmlsrc/dil.semantic.Module.html#L30" kind="variable" beg="30" end="30">moduleName</a>; <a title="Permalink to this symbol" href="#Module.moduleName" class="symlink">¶</a><a title="Go to the HTML source file" class="srclink" href="./htmlsrc/dil.semantic.Module.html#L30">#</a></dt>
<dd class="ddef">
<div class="summary">E.g.: Node</div></dd>
<dt class="decl">CompoundDeclaration <a class="symbol _variable" name="Module.root" href="./htmlsrc/dil.semantic.Module.html#L32" kind="variable" beg="32" end="32">root</a>; <a title="Permalink to this symbol" href="#Module.root" class="symlink">¶</a><a title="Go to the HTML source file" class="srclink" href="./htmlsrc/dil.semantic.Module.html#L32">#</a></dt>
<dd class="ddef">
<div class="summary">The root of the parse tree.</div></dd>
<dt class="decl">ImportDeclaration[] <a class="symbol _variable" name="Module.imports" href="./htmlsrc/dil.semantic.Module.html#L33" kind="variable" beg="33" end="33">imports</a>; <a title="Permalink to this symbol" href="#Module.imports" class="symlink">¶</a><a title="Go to the HTML source file" class="srclink" href="./htmlsrc/dil.semantic.Module.html#L33">#</a></dt>
<dd class="ddef">
<div class="summary">ImportDeclarations found in this file.</div></dd>
<dt class="decl">ModuleDeclaration <a class="symbol _variable" name="Module.moduleDecl" href="./htmlsrc/dil.semantic.Module.html#L34" kind="variable" beg="34" end="34">moduleDecl</a>; <a title="Permalink to this symbol" href="#Module.moduleDecl" class="symlink">¶</a><a title="Go to the HTML source file" class="srclink" href="./htmlsrc/dil.semantic.Module.html#L34">#</a></dt>
<dd class="ddef">
<div class="summary">The optional ModuleDeclaration in this file.</div></dd>
<dt class="decl">Parser <a class="symbol _variable" name="Module.parser" href="./htmlsrc/dil.semantic.Module.html#L35" kind="variable" beg="35" end="35">parser</a>; <a title="Permalink to this symbol" href="#Module.parser" class="symlink">¶</a><a title="Go to the HTML source file" class="srclink" href="./htmlsrc/dil.semantic.Module.html#L35">#</a></dt>
<dd class="ddef">
<div class="summary">The parser used to parse this file.</div></dd>
<dt class="decl">uint <a class="symbol _variable" name="Module.semanticPass" href="./htmlsrc/dil.semantic.Module.html#L42" kind="variable" beg="42" end="42">semanticPass</a>; <a title="Permalink to this symbol" href="#Module.semanticPass" class="symlink">¶</a><a title="Go to the HTML source file" class="srclink" href="./htmlsrc/dil.semantic.Module.html#L42">#</a></dt>
<dd class="ddef">
<div class="summary">Indicates which passes have been run on this module.</div>
0 = no pass<br/>
 1 = semantic pass 1<br/>
 2 = semantic pass 2</dd>
<dt class="decl">Module[] <a class="symbol _variable" name="Module.modules" href="./htmlsrc/dil.semantic.Module.html#L43" kind="variable" beg="43" end="43">modules</a>; <a title="Permalink to this symbol" href="#Module.modules" class="symlink">¶</a><a title="Go to the HTML source file" class="srclink" href="./htmlsrc/dil.semantic.Module.html#L43">#</a></dt>
<dd class="ddef">
<div class="summary">The imported modules.</div></dd>
<dt class="decl">Diagnostics <a class="symbol _variable" name="Module.diag" href="./htmlsrc/dil.semantic.Module.html#L45" kind="variable" beg="45" end="45">diag</a>; <a title="Permalink to this symbol" href="#Module.diag" class="symlink">¶</a><a title="Go to the HTML source file" class="srclink" href="./htmlsrc/dil.semantic.Module.html#L45">#</a></dt>
<dd class="ddef">
<div class="summary">Collects error messages.</div></dd>
<dt class="decl"><a class="symbol _ctor" name="Module.this" href="./htmlsrc/dil.semantic.Module.html#L47" kind="ctor" beg="47" end="50">this</a><span class="params">()</span>; <a title="Permalink to this symbol" href="#Module.this" class="symlink">¶</a><a title="Go to the HTML source file" class="srclink" href="./htmlsrc/dil.semantic.Module.html#L47">#</a></dt>
<dd class="ddef"></dd>
<dt class="decl"><a class="symbol _ctor" name="Module.this:2" href="./htmlsrc/dil.semantic.Module.html#L56" kind="ctor" beg="56" end="62">this</a><span class="params">(string <em>filePath</em>, Diagnostics <em>diag</em> = null)</span>; <a title="Permalink to this symbol" href="#Module.this:2" class="symlink">¶</a><a title="Go to the HTML source file" class="srclink" href="./htmlsrc/dil.semantic.Module.html#L56">#</a></dt>
<dd class="ddef">
<div class="summary">Constructs a Module object.</div>
<p class="sec_header">Params:</p>
<table class="params">
<tr><td><em>filePath</em></td><td>file path to the source text; loaded in the constructor.</td></tr>
<tr><td><em>diag</em></td><td>used for collecting error messages.</td></tr></table></dd>
<dt class="decl">string <a class="symbol _function" name="Module.filePath" href="./htmlsrc/dil.semantic.Module.html#L65" kind="function" beg="65" end="68">filePath</a><span class="params">()</span>; <a title="Permalink to this symbol" href="#Module.filePath" class="symlink">¶</a><a title="Go to the HTML source file" class="srclink" href="./htmlsrc/dil.semantic.Module.html#L65">#</a></dt>
<dd class="ddef">
<div class="summary">Returns the file path of the source text.</div></dd>
<dt class="decl">string <a class="symbol _function" name="Module.fileExtension" href="./htmlsrc/dil.semantic.Module.html#L71" kind="function" beg="71" end="77">fileExtension</a><span class="params">()</span>; <a title="Permalink to this symbol" href="#Module.fileExtension" class="symlink">¶</a><a title="Go to the HTML source file" class="srclink" href="./htmlsrc/dil.semantic.Module.html#L71">#</a></dt>
<dd class="ddef">
<div class="summary">Returns the file extension: "d" or "di".</div></dd>
<dt class="decl">void <a class="symbol _function" name="Module.setParser" href="./htmlsrc/dil.semantic.Module.html#L80" kind="function" beg="80" end="83">setParser</a><span class="params">(Parser <em>parser</em>)</span>; <a title="Permalink to this symbol" href="#Module.setParser" class="symlink">¶</a><a title="Go to the HTML source file" class="srclink" href="./htmlsrc/dil.semantic.Module.html#L80">#</a></dt>
<dd class="ddef">
<div class="summary">Sets the parser to be used for parsing the source text.</div></dd>
<dt class="decl">void <a class="symbol _function" name="Module.parse" href="./htmlsrc/dil.semantic.Module.html#L86" kind="function" beg="86" end="118">parse</a><span class="params">()</span>; <a title="Permalink to this symbol" href="#Module.parse" class="symlink">¶</a><a title="Go to the HTML source file" class="srclink" href="./htmlsrc/dil.semantic.Module.html#L86">#</a></dt>
<dd class="ddef">
<div class="summary">Parses the module.</div></dd>
<dt class="decl">Token* <a class="symbol _function" name="Module.firstToken" href="./htmlsrc/dil.semantic.Module.html#L121" kind="function" beg="121" end="124">firstToken</a><span class="params">()</span>; <a title="Permalink to this symbol" href="#Module.firstToken" class="symlink">¶</a><a title="Go to the HTML source file" class="srclink" href="./htmlsrc/dil.semantic.Module.html#L121">#</a></dt>
<dd class="ddef">
<div class="summary">Returns the first token of the module's source text.</div></dd>
<dt class="decl">Token* <a class="symbol _function" name="Module.getModuleDeclToken" href="./htmlsrc/dil.semantic.Module.html#L128" kind="function" beg="128" end="131">getModuleDeclToken</a><span class="params">()</span>; <a title="Permalink to this symbol" href="#Module.getModuleDeclToken" class="symlink">¶</a><a title="Go to the HTML source file" class="srclink" href="./htmlsrc/dil.semantic.Module.html#L128">#</a></dt>
<dd class="ddef">
<div class="summary">Returns the begin token of the module declaration
 or, if it doesn't exist, the first token in the source text.</div></dd>
<dt class="decl">bool <a class="symbol _function" name="Module.hasErrors" href="./htmlsrc/dil.semantic.Module.html#L134" kind="function" beg="134" end="137">hasErrors</a><span class="params">()</span>; <a title="Permalink to this symbol" href="#Module.hasErrors" class="symlink">¶</a><a title="Go to the HTML source file" class="srclink" href="./htmlsrc/dil.semantic.Module.html#L134">#</a></dt>
<dd class="ddef">
<div class="summary">Returns true if there are errors in the source file.</div></dd>
<dt class="decl">string[] <a class="symbol _function" name="Module.getImportPaths" href="./htmlsrc/dil.semantic.Module.html#L141" kind="function" beg="141" end="147">getImportPaths</a><span class="params">()</span>; <a title="Permalink to this symbol" href="#Module.getImportPaths" class="symlink">¶</a><a title="Go to the HTML source file" class="srclink" href="./htmlsrc/dil.semantic.Module.html#L141">#</a></dt>
<dd class="ddef">
<div class="summary">Returns a list of import paths.
 E.g.: ["dil/ast/Node", "dil/semantic/Module"]</div></dd>
<dt class="decl">string <a class="symbol _function" name="Module.getFQN" href="./htmlsrc/dil.semantic.Module.html#L151" kind="function" beg="151" end="154">getFQN</a><span class="params">()</span>; <a title="Permalink to this symbol" href="#Module.getFQN" class="symlink">¶</a><a title="Go to the HTML source file" class="srclink" href="./htmlsrc/dil.semantic.Module.html#L151">#</a></dt>
<dd class="ddef">
<div class="summary">Returns the fully qualified name of this module.
 E.g.: dil.ast.Node</div></dd>
<dt class="decl">void <a class="symbol _function" name="Module.setFQN" href="./htmlsrc/dil.semantic.Module.html#L157" kind="function" beg="157" end="173">setFQN</a><span class="params">(string <em>moduleFQN</em>)</span>; <a title="Permalink to this symbol" href="#Module.setFQN" class="symlink">¶</a><a title="Go to the HTML source file" class="srclink" href="./htmlsrc/dil.semantic.Module.html#L157">#</a></dt>
<dd class="ddef">
<div class="summary">Set's the module's FQN.</div></dd>
<dt class="decl">string <a class="symbol _function" name="Module.getFQNPath" href="./htmlsrc/dil.semantic.Module.html#L177" kind="function" beg="177" end="184">getFQNPath</a><span class="params">()</span>; <a title="Permalink to this symbol" href="#Module.getFQNPath" class="symlink">¶</a><a title="Go to the HTML source file" class="srclink" href="./htmlsrc/dil.semantic.Module.html#L177">#</a></dt>
<dd class="ddef">
<div class="summary">Returns the module's FQN with slashes instead of dots.
 E.g.: dil/ast/Node</div></dd></dl></dd></dl>
</div>
<div id="footer">
  <p>Copyright © 2007-2008, Aziz Köksal. All rights reserved.</p>
  <p>Page generated by <a href="http://code.google.com/p/dil">dil</a> on Fri Dec 26 04:12:57 2008. Rendered by <a href="http://code.google.com/p/dil/wiki/Kandil">kandil</a>.</p>
</div>
</body>
</html>